File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/UnpackCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::UnpackCommand - 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>
<li><a class="include" href="../SecurityOption.html">Gem::SecurityOption</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-description">#description</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-find_in_cache">#find_in_cache</a>
<li ><a href="#method-i-get_path">#get_path</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::UnpackCommand">
<h1 id="class-Gem::Commands::UnpackCommand" class="class">
class Gem::Commands::UnpackCommand
</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/unpack_command.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'fileutils'</span>
<span class="ruby-keyword">super</span> <span class="ruby-string">'unpack'</span>, <span class="ruby-string">'Unpack an installed gem to the current directory'</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-value">:target</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--target=DIR'</span>,
<span class="ruby-string">'target directory for unpacking'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:target</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-string">'--spec'</span>, <span class="ruby-string">'unpack the gem specification'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:spec</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_security_option</span>
<span class="ruby-identifier">add_version_option</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-description" class="method-detail ">
<div class="method-heading">
<span class="method-name">description</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="description-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/unpack_command.rb, line 48</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">description</span>
<span class="ruby-identifier"><<-EOF</span>
<span class="ruby-value">The unpack command allows you to examine the contents of a gem or modify
them to help diagnose a bug.
You can add the contents of the unpacked gem to the load path using the
RUBYLIB environment variable or -I:
$ gem unpack my_gem
Unpacked gem: '.../my_gem-1.0'
[edit my_gem-1.0/lib/my_gem.rb]
$ ruby -Imy_gem-1.0/lib -S other_program
You can repackage an unpacked gem using the build command. See the build
command help for an example.
</span><span class="ruby-identifier"> EOF</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<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/unpack_command.rb, line 75</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-identifier">security_policy</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:security_policy</span>]
<span class="ruby-identifier">get_all_gem_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">dependency</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Dependency</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>]
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">get_path</span> <span class="ruby-identifier">dependency</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"Gem '#{name}' not installed nor fetchable."</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:spec</span>]
<span class="ruby-identifier">spec</span>, <span class="ruby-identifier">metadata</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">raw_spec</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">security_policy</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">metadata</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"--spec is unsupported on '#{name}' (old format gem)"</span>
<span class="ruby-keyword">next</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">spec_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">spec_file</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:target</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:target</span>]
<span class="ruby-identifier">destination</span> = <span class="ruby-keyword">begin</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:target</span>]
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-ivar">@options</span>[<span class="ruby-value">:target</span>], <span class="ruby-identifier">spec_file</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">spec_file</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span> <span class="ruby-identifier">destination</span>, <span class="ruby-string">'w'</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">io</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">io</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">metadata</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">basename</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">path</span>, <span class="ruby-string">'.gem'</span>
<span class="ruby-identifier">target_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span> <span class="ruby-identifier">basename</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:target</span>]
<span class="ruby-identifier">package</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">path</span>, <span class="ruby-identifier">security_policy</span>
<span class="ruby-identifier">package</span>.<span class="ruby-identifier">extract_files</span> <span class="ruby-identifier">target_dir</span>
<span class="ruby-identifier">say</span> <span class="ruby-node">"Unpacked gem: '#{target_dir}'"</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-find_in_cache" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_in_cache</span><span
class="method-args">(filename)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../../Find.html"><code>Find</code></a> cached filename in <a href="../../Gem.html#method-c-path"><code>Gem.path</code></a>. Returns nil if the file cannot be found.</p>
<div class="method-source-code" id="find_in_cache-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/unpack_command.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_in_cache</span>(<span class="ruby-identifier">filename</span>)
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">this_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-string">"cache"</span>, <span class="ruby-identifier">filename</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">this_path</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">this_path</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>
<div id="method-i-get_path" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_path</span><span
class="method-args">(dependency)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the full path to the cached gem file matching the given name and version requirement. Returns 'nil' if no match.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">get_path</span> <span class="ruby-string">'rake'</span>, <span class="ruby-string">'> 0.4'</span> <span class="ruby-comment"># "/usr/lib/ruby/gems/1.8/cache/rake-0.4.2.gem"</span>
<span class="ruby-identifier">get_path</span> <span class="ruby-string">'rake'</span>, <span class="ruby-string">'< 0.1'</span> <span class="ruby-comment"># nil</span>
<span class="ruby-identifier">get_path</span> <span class="ruby-string">'rak'</span> <span class="ruby-comment"># nil (exact name required)</span>
</pre>
<div class="method-source-code" id="get_path-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/unpack_command.rb, line 155</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_path</span>(<span class="ruby-identifier">dependency</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\.gem$/i</span>
<span class="ruby-identifier">specs</span> = <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">matching_specs</span>
<span class="ruby-identifier">selected</span> = <span class="ruby-identifier">specs</span>.<span class="ruby-identifier">max_by</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span> }
<span class="ruby-keyword">return</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">RemoteFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">download_to_cache</span>(<span class="ruby-identifier">dependency</span>) <span class="ruby-keyword">unless</span>
<span class="ruby-identifier">selected</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">dependency</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^#{selected.name}$/i</span>
<span class="ruby-comment"># We expect to find (basename).gem in the 'cache' directory. Furthermore,</span>
<span class="ruby-comment"># the name match must be exact (ignoring case).</span>
<span class="ruby-identifier">path</span> = <span class="ruby-identifier">find_in_cache</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">selected</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">RemoteFetcher</span>.<span class="ruby-identifier">fetcher</span>.<span class="ruby-identifier">download_to_cache</span>(<span class="ruby-identifier">dependency</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">path</span>
<span class="ruby-identifier">path</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>