File: C:/Ruby27-x64/share/doc/ruby/html/Gem/PackageTask.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::PackageTask - 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">Rake::PackageTask
</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 class="calls-super" ><a href="#method-i-define">#define</a>
<li class="calls-super" ><a href="#method-i-init">#init</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::PackageTask">
<h1 id="class-Gem::PackageTask" class="class">
class Gem::PackageTask
</h1>
<section class="description">
<p>Create a package based upon a <a href="Specification.html"><code>Gem::Specification</code></a>. Gem packages, as well as zip files and tar/gzipped packages can be produced by this task.</p>
<p>In addition to the Rake targets generated by Rake::PackageTask, a <a href="PackageTask.html"><code>Gem::PackageTask</code></a> will also generate the following tasks:</p>
<dl class="rdoc-list label-list"><dt><strong>“<em>package_dir</em>/<em>name</em>-<em>version</em>.gem”</strong>
<dd>
<p>Create a RubyGems package with the given name and version.</p>
</dd></dl>
<p>Example using a Gem::Specification:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rubygems'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'rubygems/package_task'</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">new</span> <span class="ruby-keyword">do</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">summary</span> = <span class="ruby-string">"Ruby based make-like utility."</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">name</span> = <span class="ruby-string">'rake'</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">version</span> = <span class="ruby-constant">PKG_VERSION</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">requirements</span> <span class="ruby-operator"><<</span> <span class="ruby-string">'none'</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">files</span> = <span class="ruby-constant">PKG_FILES</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">description</span> = <span class="ruby-identifier"><<-EOF</span>
<span class="ruby-value">Rake is a Make-like program implemented in Ruby. Tasks
and dependencies are specified in standard Ruby syntax.
</span><span class="ruby-identifier"> EOF</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">PackageTask</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">spec</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pkg</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">pkg</span>.<span class="ruby-identifier">need_zip</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">pkg</span>.<span class="ruby-identifier">need_tar</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
</pre>
</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-gem_spec" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">gem_spec</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Ruby <a href="Specification.html"><code>Gem::Specification</code></a> containing the metadata for this package. The name, version and package_files are automatically determined from the gemspec and don't need to be explicitly provided.</p>
</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">(gem_spec) { |self| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a Gem Package task library. Automatically define the gem if a block is given. If no block is supplied, then <a href="PackageTask.html#method-i-define"><code>define</code></a> needs to be called to define the task.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/package_task.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">gem_spec</span>)
<span class="ruby-identifier">init</span> <span class="ruby-identifier">gem_spec</span>
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">define</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</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-define" class="method-detail ">
<div class="method-heading">
<span class="method-name">define</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create the Rake tasks and actions specified by this <a href="PackageTask.html"><code>Gem::PackageTask</code></a>. (<code>define</code> is automatically called if a block is given to <code>new</code>).</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="define-source">
<pre><span class="ruby-comment"># File lib/rubygems/package_task.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define</span>
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">gem_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span> <span class="ruby-identifier">gem_spec</span>.<span class="ruby-identifier">cache_file</span>
<span class="ruby-identifier">gem_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">package_dir</span>, <span class="ruby-identifier">gem_file</span>
<span class="ruby-identifier">gem_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span> <span class="ruby-identifier">package_dir</span>, <span class="ruby-identifier">gem_spec</span>.<span class="ruby-identifier">full_name</span>
<span class="ruby-identifier">task</span> <span class="ruby-value">:package</span> <span class="ruby-operator">=></span> [<span class="ruby-value">:gem</span>]
<span class="ruby-identifier">directory</span> <span class="ruby-identifier">package_dir</span>
<span class="ruby-identifier">directory</span> <span class="ruby-identifier">gem_dir</span>
<span class="ruby-identifier">desc</span> <span class="ruby-node">"Build the gem file #{gem_file}"</span>
<span class="ruby-identifier">task</span> <span class="ruby-value">:gem</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">gem_path</span>]
<span class="ruby-identifier">trace</span> = <span class="ruby-constant">Rake</span>.<span class="ruby-identifier">application</span>.<span class="ruby-identifier">options</span>.<span class="ruby-identifier">trace</span>
<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">verbose</span> = <span class="ruby-identifier">trace</span>
<span class="ruby-identifier">file</span> <span class="ruby-identifier">gem_path</span> <span class="ruby-operator">=></span> [<span class="ruby-identifier">package_dir</span>, <span class="ruby-identifier">gem_dir</span>] <span class="ruby-operator">+</span> <span class="ruby-ivar">@gem_spec</span>.<span class="ruby-identifier">files</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">gem_dir</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">when_writing</span> <span class="ruby-node">"Creating #{gem_spec.file_name}"</span> <span class="ruby-keyword">do</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Package</span>.<span class="ruby-identifier">build</span> <span class="ruby-identifier">gem_spec</span>
<span class="ruby-identifier">verbose</span> <span class="ruby-identifier">trace</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">mv</span> <span class="ruby-identifier">gem_file</span>, <span class="ruby-string">'..'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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-init" class="method-detail ">
<div class="method-heading">
<span class="method-name">init</span><span
class="method-args">(gem)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initialization tasks without the “yield self” or define operations.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="init-source">
<pre><span class="ruby-comment"># File lib/rubygems/package_task.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init</span>(<span class="ruby-identifier">gem</span>)
<span class="ruby-keyword">super</span> <span class="ruby-identifier">gem</span>.<span class="ruby-identifier">full_name</span>, <span class="ruby-value">:noversion</span>
<span class="ruby-ivar">@gem_spec</span> = <span class="ruby-identifier">gem</span>
<span class="ruby-ivar">@package_files</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">gem_spec</span>.<span class="ruby-identifier">files</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">gem_spec</span>.<span class="ruby-identifier">files</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>