File: C:/Ruby27-x64/share/doc/ruby/html/IRB/MethodExtender.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module IRB::MethodExtender - 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-i-def_post_proc">#def_post_proc</a>
<li ><a href="#method-i-def_pre_proc">#def_pre_proc</a>
<li ><a href="#method-i-new_alias_name">#new_alias_name</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-IRB::MethodExtender">
<h1 id="module-IRB::MethodExtender" class="module">
module IRB::MethodExtender
</h1>
<section class="description">
<p>A convenience module for extending Ruby methods.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-def_post_proc" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_post_proc</span><span
class="method-args">(base_method, extend_method)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Extends the given <code>base_method</code> with a postfix call to the given <code>extend_method</code>.</p>
<div class="method-source-code" id="def_post_proc-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 302</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_post_proc</span>(<span class="ruby-identifier">base_method</span>, <span class="ruby-identifier">extend_method</span>)
<span class="ruby-identifier">base_method</span> = <span class="ruby-identifier">base_method</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">extend_method</span> = <span class="ruby-identifier">extend_method</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">alias_name</span> = <span class="ruby-identifier">new_alias_name</span>(<span class="ruby-identifier">base_method</span>)
<span class="ruby-identifier">module_eval</span> <span class="ruby-node">%[
alias_method alias_name, base_method
def #{base_method}(*opts)
send :#{alias_name}, *opts
send :#{extend_method}, *opts
end
]</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-def_pre_proc" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_pre_proc</span><span
class="method-args">(base_method, extend_method)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Extends the given <code>base_method</code> with a prefix call to the given <code>extend_method</code>.</p>
<div class="method-source-code" id="def_pre_proc-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 286</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">def_pre_proc</span>(<span class="ruby-identifier">base_method</span>, <span class="ruby-identifier">extend_method</span>)
<span class="ruby-identifier">base_method</span> = <span class="ruby-identifier">base_method</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">extend_method</span> = <span class="ruby-identifier">extend_method</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">alias_name</span> = <span class="ruby-identifier">new_alias_name</span>(<span class="ruby-identifier">base_method</span>)
<span class="ruby-identifier">module_eval</span> <span class="ruby-node">%[
alias_method alias_name, base_method
def #{base_method}(*opts)
send :#{extend_method}, *opts
send :#{alias_name}, *opts
end
]</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-new_alias_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_alias_name</span><span
class="method-args">(name, prefix = "__alias_of__", postfix = "__")</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a unique method name to use as an alias for the given <code>name</code>.</p>
<p>Usually returns <code>#{prefix}#{name}#{postfix}<num></code>, example:</p>
<pre class="ruby"><span class="ruby-identifier">new_alias_name</span>(<span class="ruby-string">'foo'</span>) <span class="ruby-comment">#=> __alias_of__foo__</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bar</span>; <span class="ruby-keyword">end</span>
<span class="ruby-identifier">new_alias_name</span>(<span class="ruby-string">'bar'</span>) <span class="ruby-comment">#=> __alias_of__bar__2</span>
</pre>
<div class="method-source-code" id="new_alias_name-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 323</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_alias_name</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">prefix</span> = <span class="ruby-string">"__alias_of__"</span>, <span class="ruby-identifier">postfix</span> = <span class="ruby-string">"__"</span>)
<span class="ruby-identifier">base_name</span> = <span class="ruby-node">"#{prefix}#{name}#{postfix}"</span>
<span class="ruby-identifier">all_methods</span> = <span class="ruby-identifier">instance_methods</span>(<span class="ruby-keyword">true</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">private_instance_methods</span>(<span class="ruby-keyword">true</span>)
<span class="ruby-identifier">same_methods</span> = <span class="ruby-identifier">all_methods</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-regexp">/^#{Regexp.quote(base_name)}[0-9]*$/</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">base_name</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">same_methods</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">no</span> = <span class="ruby-identifier">same_methods</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword">while</span> <span class="ruby-operator">!</span><span class="ruby-identifier">same_methods</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">alias_name</span> = <span class="ruby-identifier">base_name</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">no</span>)
<span class="ruby-identifier">no</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">alias_name</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>