File: C:/Ruby27-x64/share/doc/ruby/html/IRB/Inspector.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class IRB::Inspector - 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-def_inspector">::def_inspector</a>
<li ><a href="#method-c-keys_with_inspector">::keys_with_inspector</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-init">#init</a>
<li ><a href="#method-i-inspect_value">#inspect_value</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-IRB::Inspector">
<h1 id="class-IRB::Inspector" class="class">
class IRB::Inspector
</h1>
<section class="description">
<p>An irb inspector</p>
<p>In order to create your own custom inspector there are two things you should be aware of:</p>
<p><a href="Inspector.html"><code>Inspector</code></a> uses <a href="Inspector.html#method-i-inspect_value"><code>inspect_value</code></a>, or <code>inspect_proc</code>, for output of return values.</p>
<p>This also allows for an optional <a href="Inspector.html#method-i-init"><code>init</code></a>+, or <code>init_proc</code>, which is called when the inspector is activated.</p>
<p>Knowing this, you can create a rudimentary inspector as follows:</p>
<pre>irb(main):001:0> ins = IRB::Inspector.new(proc{ |v| "omg! #{v}" })
irb(main):001:0> IRB.CurrentContext.inspect_mode = ins # => omg! #<IRB::Inspector:0x007f46f7ba7d28>
irb(main):001:0> "what?" #=> omg! what?</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="INSPECTORS">INSPECTORS
<dd><p>Default inspectors available to irb, this includes:</p>
<dl class="rdoc-list note-list"><dt><code>:pp</code>
<dd>
<p>Using <a href="../Kernel.html#method-i-pretty_inspect"><code>Kernel#pretty_inspect</code></a></p>
</dd><dt><code>:yaml</code>
<dd>
<p>Using YAML.dump</p>
</dd><dt><code>:marshal</code>
<dd>
<p>Using <a href="../Marshal.html#method-c-dump"><code>Marshal.dump</code></a></p>
</dd></dl>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-def_inspector" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_inspector</span><span
class="method-args">(key, arg=nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Example</p>
<pre>Inspector.def_inspector(key, init_p=nil){|v| v.inspect}
Inspector.def_inspector([key1,..], init_p=nil){|v| v.inspect}
Inspector.def_inspector(key, inspector)
Inspector.def_inspector([key1,...], inspector)</pre>
<div class="method-source-code" id="def_inspector-source">
<pre><span class="ruby-comment"># File lib/irb/inspector.rb, line 64</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">def_inspector</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">arg</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">inspector</span> = <span class="ruby-constant">IRB</span><span class="ruby-operator">::</span><span class="ruby-constant">Inspector</span>(<span class="ruby-identifier">block</span>, <span class="ruby-identifier">arg</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">inspector</span> = <span class="ruby-identifier">arg</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-keyword">for</span> <span class="ruby-identifier">k</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">key</span>
<span class="ruby-identifier">def_inspector</span>(<span class="ruby-identifier">k</span>, <span class="ruby-identifier">inspector</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-constant">INSPECTORS</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">inspector</span>
<span class="ruby-constant">INSPECTORS</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">inspector</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-constant">INSPECTORS</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">inspector</span>
<span class="ruby-constant">INSPECTORS</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">intern</span>] = <span class="ruby-identifier">inspector</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">INSPECTORS</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">inspector</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-keys_with_inspector" class="method-detail ">
<div class="method-heading">
<span class="method-name">keys_with_inspector</span><span
class="method-args">(inspector)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Determines the inspector to use where <code>inspector</code> is one of the keys passed during inspector definition.</p>
<div class="method-source-code" id="keys_with_inspector-source">
<pre><span class="ruby-comment"># File lib/irb/inspector.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">keys_with_inspector</span>(<span class="ruby-identifier">inspector</span>)
<span class="ruby-constant">INSPECTORS</span>.<span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">inspector</span>}.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(inspect_proc, init_proc = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new inspector object, using the given <code>inspect_proc</code> when output return values in irb.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/irb/inspector.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">inspect_proc</span>, <span class="ruby-identifier">init_proc</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@init</span> = <span class="ruby-identifier">init_proc</span>
<span class="ruby-ivar">@inspect</span> = <span class="ruby-identifier">inspect_proc</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-init" class="method-detail ">
<div class="method-heading">
<span class="method-name">init</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Proc.html"><code>Proc</code></a> to call when the inspector is activated, good for requiring dependent libraries.</p>
<div class="method-source-code" id="init-source">
<pre><span class="ruby-comment"># File lib/irb/inspector.rb, line 96</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init</span>
<span class="ruby-ivar">@init</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@init</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect_value" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect_value</span><span
class="method-args">(v)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Proc.html"><code>Proc</code></a> to call when the input is evaluated and output in irb.</p>
<div class="method-source-code" id="inspect_value-source">
<pre><span class="ruby-comment"># File lib/irb/inspector.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect_value</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-ivar">@inspect</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">v</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>