File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/ContentsCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::ContentsCommand - 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="../Command.html">Gem::Command</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../VersionOption.html">Gem::VersionOption</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-files_in">#files_in</a>
<li ><a href="#method-i-files_in_default_gem">#files_in_default_gem</a>
<li ><a href="#method-i-files_in_gem">#files_in_gem</a>
<li ><a href="#method-i-gem_contents">#gem_contents</a>
<li ><a href="#method-i-gem_install_dir">#gem_install_dir</a>
<li ><a href="#method-i-show_files">#show_files</a>
<li ><a href="#method-i-spec_for">#spec_for</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::ContentsCommand">
<h1 id="class-Gem::Commands::ContentsCommand" class="class">
class Gem::Commands::ContentsCommand
</h1>
<section class="description">
</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-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-calls-super">
Calls superclass method
<a href="../Command.html#method-c-new"><code>Gem::Command::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 10</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-keyword">super</span> <span class="ruby-string">'contents'</span>, <span class="ruby-string">'Display the contents of the installed gems'</span>,
<span class="ruby-value">:specdirs</span> <span class="ruby-operator">=></span> [], <span class="ruby-value">:lib_only</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-value">:show_install_dir</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>
<span class="ruby-identifier">add_version_option</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--all'</span>,
<span class="ruby-string">"Contents for all gems"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">all</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:all</span>] = <span class="ruby-identifier">all</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-s'</span>, <span class="ruby-string">'--spec-dir a,b,c'</span>, <span class="ruby-constant">Array</span>,
<span class="ruby-string">"Search for gems under specific paths"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">spec_dirs</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:specdirs</span>] = <span class="ruby-identifier">spec_dirs</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'-l'</span>, <span class="ruby-string">'--[no-]lib-only'</span>,
<span class="ruby-string">"Only return files in the Gem's lib_dirs"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">lib_only</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:lib_only</span>] = <span class="ruby-identifier">lib_only</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--[no-]prefix'</span>,
<span class="ruby-string">"Don't include installed path prefix"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:prefix</span>] = <span class="ruby-identifier">prefix</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--[no-]show-install-dir'</span>,
<span class="ruby-string">'Show only the gem install dir'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">show</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:show_install_dir</span>] = <span class="ruby-identifier">show</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@path_kind</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@spec_dirs</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-keyword">nil</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-execute" class="method-detail ">
<div class="method-heading">
<span class="method-name">execute</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="execute-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-ivar">@version</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Requirement</span>.<span class="ruby-identifier">default</span>
<span class="ruby-ivar">@spec_dirs</span> = <span class="ruby-identifier">specification_directories</span>
<span class="ruby-ivar">@path_kind</span> = <span class="ruby-identifier">path_description</span> <span class="ruby-ivar">@spec_dirs</span>
<span class="ruby-identifier">names</span> = <span class="ruby-identifier">gem_names</span>
<span class="ruby-identifier">names</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">found</span> =
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:show_install_dir</span>]
<span class="ruby-identifier">gem_install_dir</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">gem_contents</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">terminate_interaction</span> <span class="ruby-value">1</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">found</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">names</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-files_in" class="method-detail ">
<div class="method-heading">
<span class="method-name">files_in</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="files_in-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 86</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">files_in</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">default_gem?</span>
<span class="ruby-identifier">files_in_default_gem</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">files_in_gem</span> <span class="ruby-identifier">spec</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-files_in_default_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">files_in_default_gem</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="files_in_default_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">files_in_default_gem</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-identifier">spec</span>.<span class="ruby-identifier">files</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">file</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A#{spec.bindir}\//</span>
[<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-string">'bindir'</span>], <span class="ruby-identifier">$POSTMATCH</span>]
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\.so\z/</span>
[<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-string">'archdir'</span>], <span class="ruby-identifier">file</span>]
<span class="ruby-keyword">else</span>
[<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-string">'rubylibdir'</span>], <span class="ruby-identifier">file</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-files_in_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">files_in_gem</span><span
class="method-args">(spec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="files_in_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">files_in_gem</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-identifier">gem_path</span> = <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">full_gem_path</span>
<span class="ruby-identifier">extra</span> = <span class="ruby-node">"/{#{spec.require_paths.join ','}}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:lib_only</span>]
<span class="ruby-identifier">glob</span> = <span class="ruby-node">"#{gem_path}#{extra}/**/*"</span>
<span class="ruby-identifier">prefix_re</span> = <span class="ruby-regexp">/#{Regexp.escape(gem_path)}\//</span>
<span class="ruby-constant">Dir</span>[<span class="ruby-identifier">glob</span>].<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
[<span class="ruby-identifier">gem_path</span>, <span class="ruby-identifier">file</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">prefix_re</span>, <span class="ruby-string">""</span>)]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_contents" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_contents</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="gem_contents-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_contents</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">spec</span> = <span class="ruby-identifier">spec_for</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">files</span> = <span class="ruby-identifier">files_in</span> <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">show_files</span> <span class="ruby-identifier">files</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gem_install_dir" class="method-detail ">
<div class="method-heading">
<span class="method-name">gem_install_dir</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="gem_install_dir-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 130</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gem_install_dir</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">spec</span> = <span class="ruby-identifier">spec_for</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">say</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">gem_dir</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-show_files" class="method-detail ">
<div class="method-heading">
<span class="method-name">show_files</span><span
class="method-args">(files)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="show_files-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 156</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">show_files</span>(<span class="ruby-identifier">files</span>)
<span class="ruby-identifier">files</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">basename</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">absolute_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">basename</span>)
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-identifier">absolute_path</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:prefix</span>]
<span class="ruby-identifier">say</span> <span class="ruby-identifier">absolute_path</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">say</span> <span class="ruby-identifier">basename</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-spec_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec_for</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="spec_for-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/contents_command.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec_for</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">spec</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">find_all_by_name</span>(<span class="ruby-identifier">name</span>, <span class="ruby-ivar">@version</span>).<span class="ruby-identifier">last</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">spec</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Unable to find gem '#{name}' in #{@path_kind}"</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">verbose</span>
<span class="ruby-identifier">say</span> <span class="ruby-string">"\nDirectories searched:"</span>
<span class="ruby-ivar">@spec_dirs</span>.<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-identifier">say</span> <span class="ruby-identifier">dir</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</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>