123456789_123456789_123456789_123456789_123456789_

Module: Gem::Deprecate

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
BasicSpecification, Commands::QueryCommand, Commands::ServerCommand, ConsoleUI, DependencyInstaller, Installer, MockGemUi, SilentUI, Specification, StreamUI, StubSpecification, 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 Attribute Summary

Class Method Summary

Instance Method Summary

Class Attribute Details

.skip (rw)

This method is for internal use only.
[ GitHub ] 

  


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



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


  








  

    .skip=(v)   (rw)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  







Class Method Details



  

    .next_rubygems_major_version  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# 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)   (mod_func)
  



  

    

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.


  



  [ GitHub ]


  

  


# 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   (mod_func)
  



  

    

Deprecation method to deprecate Rubygems commands


  



  [ GitHub ]


  

  


# 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   (mod_func)
  



  

    

Temporarily turn off warnings. Intended for tests only.


  



  [ GitHub ]


  

  


# 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)  
  



  

    

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.


  



  [ GitHub ]


  

  


# 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