File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Package/Old.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Package::Old - 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="../Package.html">Gem::Package</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-contents">#contents</a>
<li ><a href="#method-i-extract_files">#extract_files</a>
<li ><a href="#method-i-spec">#spec</a>
<li ><a href="#method-i-verify">#verify</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Package::Old">
<h1 id="class-Gem::Package::Old" class="class">
class Gem::Package::Old
</h1>
<section class="description">
<p>The format class knows the guts of the ancient .gem file format and provides the capability to read such ancient gems.</p>
<p>Please pretend this doesn't exist.</p>
</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">(gem, security_policy)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new old-format package reader for <code>gem</code>. Old-format packages cannot be written.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/old.rb, line 22</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">gem</span>, <span class="ruby-identifier">security_policy</span>)
<span class="ruby-identifier">require</span> <span class="ruby-string">'fileutils'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'zlib'</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">load_yaml</span>
<span class="ruby-ivar">@contents</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@gem</span> = <span class="ruby-identifier">gem</span>
<span class="ruby-ivar">@security_policy</span> = <span class="ruby-identifier">security_policy</span>
<span class="ruby-ivar">@spec</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-contents" class="method-detail ">
<div class="method-heading">
<span class="method-name">contents</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A list of file names contained in this gem</p>
<div class="method-source-code" id="contents-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/old.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">contents</span>
<span class="ruby-identifier">verify</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@contents</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@contents</span>
<span class="ruby-ivar">@gem</span>.<span class="ruby-identifier">with_read_io</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">read_until_dashes</span> <span class="ruby-identifier">io</span> <span class="ruby-comment"># spec</span>
<span class="ruby-identifier">header</span> = <span class="ruby-identifier">file_list</span> <span class="ruby-identifier">io</span>
<span class="ruby-ivar">@contents</span> = <span class="ruby-identifier">header</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span> <span class="ruby-identifier">file</span>[<span class="ruby-string">'path'</span>] }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-extract_files" class="method-detail ">
<div class="method-heading">
<span class="method-name">extract_files</span><span
class="method-args">(destination_dir)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Extracts the files in this package into <code>destination_dir</code></p>
<div class="method-source-code" id="extract_files-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/old.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">extract_files</span>(<span class="ruby-identifier">destination_dir</span>)
<span class="ruby-identifier">verify</span>
<span class="ruby-identifier">errstr</span> = <span class="ruby-string">"Error reading files from gem"</span>
<span class="ruby-ivar">@gem</span>.<span class="ruby-identifier">with_read_io</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">read_until_dashes</span> <span class="ruby-identifier">io</span> <span class="ruby-comment"># spec</span>
<span class="ruby-identifier">header</span> = <span class="ruby-identifier">file_list</span> <span class="ruby-identifier">io</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>, <span class="ruby-identifier">errstr</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">header</span>
<span class="ruby-identifier">header</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">full_name</span> = <span class="ruby-identifier">entry</span>[<span class="ruby-string">'path'</span>]
<span class="ruby-identifier">destination</span> = <span class="ruby-identifier">install_location</span> <span class="ruby-identifier">full_name</span>, <span class="ruby-identifier">destination_dir</span>
<span class="ruby-identifier">file_data</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">read_until_dashes</span> <span class="ruby-identifier">io</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">file_data</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">file_data</span> = <span class="ruby-identifier">file_data</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">unpack</span>(<span class="ruby-string">"m"</span>)[<span class="ruby-value">0</span>]
<span class="ruby-identifier">file_data</span> = <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">Inflate</span>.<span class="ruby-identifier">inflate</span> <span class="ruby-identifier">file_data</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span><span class="ruby-operator">::</span><span class="ruby-constant">FormatError</span>, <span class="ruby-node">"#{full_name} in #{@gem} is corrupt"</span> <span class="ruby-keyword">if</span>
<span class="ruby-identifier">file_data</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">entry</span>[<span class="ruby-string">'size'</span>].<span class="ruby-identifier">to_i</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span> <span class="ruby-identifier">destination</span>
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">destination</span>), <span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">dir_mode</span> <span class="ruby-operator">&&</span> <span class="ruby-value">0755</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span> <span class="ruby-identifier">destination</span>, <span class="ruby-string">'wb'</span>, <span class="ruby-identifier">file_mode</span>(<span class="ruby-identifier">entry</span>[<span class="ruby-string">'mode'</span>]) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">out</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">out</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">file_data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-identifier">destination</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">DataError</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>, <span class="ruby-identifier">errstr</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-spec" class="method-detail ">
<div class="method-heading">
<span class="method-name">spec</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The specification for this gem</p>
<div class="method-source-code" id="spec-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/old.rb, line 133</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spec</span>
<span class="ruby-identifier">verify</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@spec</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@spec</span>
<span class="ruby-identifier">yaml</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@gem</span>.<span class="ruby-identifier">with_read_io</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">skip_ruby</span> <span class="ruby-identifier">io</span>
<span class="ruby-identifier">read_until_dashes</span> <span class="ruby-identifier">io</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">yaml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@spec</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Specification</span>.<span class="ruby-identifier">from_yaml</span> <span class="ruby-identifier">yaml</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-constant">SyntaxError</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to parse gem specification out of gem file"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ArgumentError</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to parse gem specification out of gem file"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-verify" class="method-detail ">
<div class="method-heading">
<span class="method-name">verify</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Raises an exception if a security policy that verifies data is active. <a href="Old.html"><code>Old</code></a> format gems cannot be verified as signed.</p>
<div class="method-source-code" id="verify-source">
<pre><span class="ruby-comment"># File lib/rubygems/package/old.rb, line 160</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verify</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@security_policy</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Security</span><span class="ruby-operator">::</span><span class="ruby-constant">Exception</span>,
<span class="ruby-string">'old format gems do not contain signatures and cannot be verified'</span> <span class="ruby-keyword">if</span>
<span class="ruby-ivar">@security_policy</span>.<span class="ruby-identifier">verify_data</span>
<span class="ruby-keyword">true</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>