File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Deprecate.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::Deprecate - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-deprecate">::deprecate</a>
<li ><a href="#method-c-skip_during">::skip_during</a>
<li ><a href="#method-i-deprecate">#deprecate</a>
<li ><a href="#method-i-skip_during">#skip_during</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::Deprecate">
<h1 id="module-Gem::Deprecate" class="module">
module Gem::Deprecate
</h1>
<section class="description">
<p>Provides a single method <code>deprecate</code> to be used to declare when something is going away.</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Legacy</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">klass_method</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">instance_method</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>
<span class="ruby-identifier">deprecate</span> <span class="ruby-value">:instance_method</span>, <span class="ruby-string">"X.z"</span>, <span class="ruby-value">2011</span>, <span class="ruby-value">4</span>
<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>
<span class="ruby-identifier">extend</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>
<span class="ruby-identifier">deprecate</span> <span class="ruby-value">:klass_method</span>, <span class="ruby-value">:none</span>, <span class="ruby-value">2011</span>, <span class="ruby-value">4</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-deprecate" class="method-detail ">
<div class="method-heading">
<span class="method-name">deprecate</span><span
class="method-args">(name, repl, year, month)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Simple deprecation method that deprecates <code>name</code> by wrapping it up in a dummy method. It warns on each call to the dummy method telling the user of <code>repl</code> (unless <code>repl</code> is :none) and the year/month that it is planned to go away.</p>
<div class="method-source-code" id="deprecate-source">
<pre><span class="ruby-comment"># File lib/rubygems/deprecate.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deprecate</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">repl</span>, <span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>)
<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">old</span> = <span class="ruby-node">"_deprecated_#{name}"</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">old</span>, <span class="ruby-identifier">name</span>
<span class="ruby-identifier">define_method</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">klass</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Module</span>
<span class="ruby-identifier">target</span> = <span class="ruby-identifier">klass</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{self}."</span> <span class="ruby-operator">:</span> <span class="ruby-node">"#{self.class}#"</span>
<span class="ruby-identifier">msg</span> = [ <span class="ruby-node">"NOTE: #{target}#{name} is deprecated"</span>,
<span class="ruby-identifier">repl</span> <span class="ruby-operator">==</span> <span class="ruby-value">:none</span> <span class="ruby-operator">?</span> <span class="ruby-string">" with no replacement"</span> <span class="ruby-operator">:</span> <span class="ruby-node">"; use #{repl} instead"</span>,
<span class="ruby-string">". It will be removed on or after %4d-%02d-01."</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>],
<span class="ruby-node">"\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}"</span>,
]
<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{msg.join}."</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>
<span class="ruby-identifier">send</span> <span class="ruby-identifier">old</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-skip_during" class="method-detail ">
<div class="method-heading">
<span class="method-name">skip_during</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Temporarily turn off warnings. Intended for tests only.</p>
<div class="method-source-code" id="skip_during-source">
<pre><span class="ruby-comment"># File lib/rubygems/deprecate.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">skip_during</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>, <span class="ruby-identifier">original</span> = <span class="ruby-keyword">true</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span> = <span class="ruby-identifier">original</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-deprecate" class="method-detail ">
<div class="method-heading">
<span class="method-name">deprecate</span><span
class="method-args">(name, repl, year, month)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Simple deprecation method that deprecates <code>name</code> by wrapping it up in a dummy method. It warns on each call to the dummy method telling the user of <code>repl</code> (unless <code>repl</code> is :none) and the year/month that it is planned to go away.</p>
<div class="method-source-code" id="deprecate-source">
<pre><span class="ruby-comment"># File lib/rubygems/deprecate.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deprecate</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">repl</span>, <span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>)
<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">old</span> = <span class="ruby-node">"_deprecated_#{name}"</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">old</span>, <span class="ruby-identifier">name</span>
<span class="ruby-identifier">define_method</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">klass</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Module</span>
<span class="ruby-identifier">target</span> = <span class="ruby-identifier">klass</span> <span class="ruby-operator">?</span> <span class="ruby-node">"#{self}."</span> <span class="ruby-operator">:</span> <span class="ruby-node">"#{self.class}#"</span>
<span class="ruby-identifier">msg</span> = [ <span class="ruby-node">"NOTE: #{target}#{name} is deprecated"</span>,
<span class="ruby-identifier">repl</span> <span class="ruby-operator">==</span> <span class="ruby-value">:none</span> <span class="ruby-operator">?</span> <span class="ruby-string">" with no replacement"</span> <span class="ruby-operator">:</span> <span class="ruby-node">"; use #{repl} instead"</span>,
<span class="ruby-string">". It will be removed on or after %4d-%02d-01."</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>],
<span class="ruby-node">"\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}"</span>,
]
<span class="ruby-identifier">warn</span> <span class="ruby-node">"#{msg.join}."</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>
<span class="ruby-identifier">send</span> <span class="ruby-identifier">old</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-skip_during" class="method-detail ">
<div class="method-heading">
<span class="method-name">skip_during</span><span
class="method-args">() { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Temporarily turn off warnings. Intended for tests only.</p>
<div class="method-source-code" id="skip_during-source">
<pre><span class="ruby-comment"># File lib/rubygems/deprecate.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">skip_during</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>, <span class="ruby-identifier">original</span> = <span class="ruby-keyword">true</span>, <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Deprecate</span>.<span class="ruby-identifier">skip</span> = <span class="ruby-identifier">original</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>