File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Commands/BuildCommand.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Commands::BuildCommand - 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>
<!-- 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-build_gem">#build_gem</a>
<li ><a href="#method-i-build_package">#build_package</a>
<li ><a href="#method-i-execute">#execute</a>
<li ><a href="#method-i-find_gemspec">#find_gemspec</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Commands::BuildCommand">
<h1 id="class-Gem::Commands::BuildCommand" class="class">
class Gem::Commands::BuildCommand
</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/build_command.rb, line 7</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">'build'</span>, <span class="ruby-string">'Build a gem from a gemspec'</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'--force'</span>, <span class="ruby-string">'skip validation of the spec'</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">:force</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'--strict'</span>, <span class="ruby-string">'consider warnings as errors when validating the spec'</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">:strict</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'-o'</span>, <span class="ruby-string">'--output FILE'</span>, <span class="ruby-string">'output gem with the given filename'</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">:output</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span> <span class="ruby-string">'-C PATH'</span>, <span class="ruby-string">''</span>, <span class="ruby-string">'Run as if gem build was started in <PATH> instead of the current working directory.'</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">:build_path</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</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/build_command.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute</span>
<span class="ruby-identifier">gem_name</span> = <span class="ruby-identifier">get_one_optional_argument</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">find_gemspec</span>
<span class="ruby-identifier">build_gem</span>(<span class="ruby-identifier">gem_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-build_gem" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_gem</span><span
class="method-args">(gem_name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="build_gem-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/build_command.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_gem</span>(<span class="ruby-identifier">gem_name</span>)
<span class="ruby-identifier">gemspec</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">gem_name</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">gem_name</span> <span class="ruby-operator">:</span> <span class="ruby-node">"#{gem_name}.gemspec"</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">gemspec</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">load</span>(<span class="ruby-identifier">gemspec</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:build_path</span>]
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">gemspec</span>)) <span class="ruby-keyword">do</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">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">gemspec</span>))
<span class="ruby-identifier">build_package</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">build_package</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"Gemspec file not found: #{gemspec}"</span>
<span class="ruby-identifier">terminate_interaction</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-build_package" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_package</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="build_package-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/build_command.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_package</span>(<span class="ruby-identifier">spec</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">spec</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">spec</span>,
<span class="ruby-identifier">options</span>[<span class="ruby-value">:force</span>],
<span class="ruby-identifier">options</span>[<span class="ruby-value">:strict</span>],
<span class="ruby-identifier">options</span>[<span class="ruby-value">:output</span>]
)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-string">"Error loading gemspec. Aborting."</span>
<span class="ruby-identifier">terminate_interaction</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-find_gemspec" class="method-detail ">
<div class="method-heading">
<span class="method-name">find_gemspec</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="find_gemspec-source">
<pre><span class="ruby-comment"># File lib/rubygems/commands/build_command.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_gemspec</span>
<span class="ruby-identifier">gemspecs</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-string">"*.gemspec"</span>).<span class="ruby-identifier">sort</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gemspecs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
<span class="ruby-identifier">alert_error</span> <span class="ruby-node">"Multiple gemspecs found: #{gemspecs}, please specify one"</span>
<span class="ruby-identifier">terminate_interaction</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">gemspecs</span>.<span class="ruby-identifier">first</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>