File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Plugin/Index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Plugin::Index - 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-new">::new</a>
<li ><a href="#method-i-command_plugin">#command_plugin</a>
<li ><a href="#method-i-global_index_file">#global_index_file</a>
<li ><a href="#method-i-hook_plugins">#hook_plugins</a>
<li ><a href="#method-i-index_file">#index_file</a>
<li ><a href="#method-i-installed-3F">#installed?</a>
<li ><a href="#method-i-installed_plugins">#installed_plugins</a>
<li ><a href="#method-i-load_index">#load_index</a>
<li ><a href="#method-i-load_paths">#load_paths</a>
<li ><a href="#method-i-local_index_file">#local_index_file</a>
<li ><a href="#method-i-plugin_commands">#plugin_commands</a>
<li ><a href="#method-i-plugin_path">#plugin_path</a>
<li ><a href="#method-i-register_plugin">#register_plugin</a>
<li ><a href="#method-i-save_index">#save_index</a>
<li ><a href="#method-i-source-3F">#source?</a>
<li ><a href="#method-i-source_plugin">#source_plugin</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Plugin::Index">
<h1 id="class-Bundler::Plugin::Index" class="class">
class Bundler::Plugin::Index
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-commands" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">commands</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@plugin_paths</span> = {}
<span class="ruby-ivar">@commands</span> = {}
<span class="ruby-ivar">@sources</span> = {}
<span class="ruby-ivar">@hooks</span> = {}
<span class="ruby-ivar">@load_paths</span> = {}
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">load_index</span>(<span class="ruby-identifier">global_index_file</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">GenericSystemCallError</span>
<span class="ruby-comment"># no need to fail when on a read-only FS, for example</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">load_index</span>(<span class="ruby-identifier">local_index_file</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">in_bundle?</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-command_plugin" class="method-detail ">
<div class="method-heading">
<span class="method-name">command_plugin</span><span
class="method-args">(command)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetch the name of plugin handling the command</p>
<div class="method-source-code" id="command_plugin-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">command_plugin</span>(<span class="ruby-identifier">command</span>)
<span class="ruby-ivar">@commands</span>[<span class="ruby-identifier">command</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-global_index_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">global_index_file</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Path where the global index file is stored</p>
<div class="method-source-code" id="global_index_file-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 80</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">global_index_file</span>
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">global_root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"index"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hook_plugins" class="method-detail ">
<div class="method-heading">
<span class="method-name">hook_plugins</span><span
class="method-args">(event)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the list of plugin names handling the passed event</p>
<div class="method-source-code" id="hook_plugins-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 123</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hook_plugins</span>(<span class="ruby-identifier">event</span>)
<span class="ruby-ivar">@hooks</span>[<span class="ruby-identifier">event</span>] <span class="ruby-operator">||</span> []
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-index_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">index_file</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Path of default index file</p>
<div class="method-source-code" id="index_file-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index_file</span>
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"index"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-installed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">installed?</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="installed-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installed?</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-installed_plugins" class="method-detail ">
<div class="method-heading">
<span class="method-name">installed_plugins</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="installed_plugins-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installed_plugins</span>
<span class="ruby-ivar">@plugin_paths</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-load_paths" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_paths</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="load_paths-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 93</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_paths</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@load_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-local_index_file" class="method-detail ">
<div class="method-heading">
<span class="method-name">local_index_file</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Path where the local index file is stored</p>
<div class="method-source-code" id="local_index_file-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 85</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">local_index_file</span>
<span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">local_root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"index"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-plugin_commands" class="method-detail ">
<div class="method-heading">
<span class="method-name">plugin_commands</span><span
class="method-args">(plugin)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="plugin_commands-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">plugin_commands</span>(<span class="ruby-identifier">plugin</span>)
<span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">find_all</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">plugin</span> }.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&</span><span class="ruby-value">:first</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-plugin_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">plugin_path</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="plugin_path-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">plugin_path</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-register_plugin" class="method-detail ">
<div class="method-heading">
<span class="method-name">register_plugin</span><span
class="method-args">(name, path, load_paths, commands, sources, hooks)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This function is to be called when a new plugin is installed. This function shall add the functions of the plugin to existing maps and also the name to source location.</p>
<p>@param [String] name of the plugin to be registered @param [String] path where the plugin is installed @param [Array<String>] <a href="Index.html#method-i-load_paths"><code>load_paths</code></a> for the plugin @param [Array<String>] commands that are handled by the plugin @param [Array<String>] sources that are handled by the plugin</p>
<div class="method-source-code" id="register_plugin-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">register_plugin</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">load_paths</span>, <span class="ruby-identifier">commands</span>, <span class="ruby-identifier">sources</span>, <span class="ruby-identifier">hooks</span>)
<span class="ruby-identifier">old_commands</span> = <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-identifier">common</span> = <span class="ruby-identifier">commands</span> <span class="ruby-operator">&</span> <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">CommandConflict</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">common</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">common</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">commands</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@commands</span>[<span class="ruby-identifier">c</span>] = <span class="ruby-identifier">name</span> }
<span class="ruby-identifier">common</span> = <span class="ruby-identifier">sources</span> <span class="ruby-operator">&</span> <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">SourceConflict</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">common</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">common</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">sources</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@sources</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">name</span> }
<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">event</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">event_hooks</span> = (<span class="ruby-ivar">@hooks</span>[<span class="ruby-identifier">event</span>] <span class="ruby-operator">||=</span> []) <span class="ruby-operator"><<</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">event_hooks</span>.<span class="ruby-identifier">uniq!</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">path</span>
<span class="ruby-ivar">@load_paths</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">load_paths</span>
<span class="ruby-identifier">save_index</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span>
<span class="ruby-ivar">@commands</span> = <span class="ruby-identifier">old_commands</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-source-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">source?</span><span
class="method-args">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="source-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 114</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source?</span>(<span class="ruby-identifier">source</span>)
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-source_plugin" class="method-detail ">
<div class="method-heading">
<span class="method-name">source_plugin</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="source_plugin-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source_plugin</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@sources</span>[<span class="ruby-identifier">name</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-load_index" class="method-detail ">
<div class="method-heading">
<span class="method-name">load_index</span><span
class="method-args">(index_file, global = false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads the index file from the directory and initializes the instance variables.</p>
<p>It skips the sources if the second param is true @param [Pathname] index file path @param [Boolean] is the index file global index</p>
<div class="method-source-code" id="load_index-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 135</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_index</span>(<span class="ruby-identifier">index_file</span>, <span class="ruby-identifier">global</span> = <span class="ruby-keyword">false</span>)
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">index_file</span>, <span class="ruby-value">:read</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index_f</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">valid_file</span> = <span class="ruby-identifier">index_f</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">valid_file</span>
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">read</span>
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">"../yaml_serializer"</span>
<span class="ruby-identifier">index</span> = <span class="ruby-constant">YAMLSerializer</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">"commands"</span>])
<span class="ruby-ivar">@hooks</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">"hooks"</span>])
<span class="ruby-ivar">@load_paths</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">"load_paths"</span>])
<span class="ruby-ivar">@plugin_paths</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">"plugin_paths"</span>])
<span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">"sources"</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">global</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-save_index" class="method-detail ">
<div class="method-heading">
<span class="method-name">save_index</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Should be called when any of the instance variables change. Stores the instance variables in YAML format. (The instance variables are supposed to be only <a href="../../String.html"><code>String</code></a> key value pairs)</p>
<div class="method-source-code" id="save_index-source">
<pre><span class="ruby-comment"># File lib/bundler/plugin/index.rb, line 156</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save_index</span>
<span class="ruby-identifier">index</span> = {
<span class="ruby-string">"commands"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@commands</span>,
<span class="ruby-string">"hooks"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@hooks</span>,
<span class="ruby-string">"load_paths"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@load_paths</span>,
<span class="ruby-string">"plugin_paths"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@plugin_paths</span>,
<span class="ruby-string">"sources"</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@sources</span>,
}
<span class="ruby-identifier">require_relative</span> <span class="ruby-string">"../yaml_serializer"</span>
<span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">index_file</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index_f</span><span class="ruby-operator">|</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">dirname</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">index_f</span>, <span class="ruby-string">"w"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">YAMLSerializer</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">index</span>) }
<span class="ruby-keyword">end</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>